/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tika.exception;

/*
 * Thrown when a parser is asked to allocate more memory than is allowable
 * for a given threshold.  For example, the ZCompressorInputStream might
 * be asked to create an array many gigabytes of length by a corrupt file.
 */
public class TikaMemoryLimitException extends TikaException {

    public TikaMemoryLimitException(String msg) {
        super(msg);
    }

    public TikaMemoryLimitException(long triedToAllocate, long maxAllowable) {
        super(msg(triedToAllocate, maxAllowable));
    }

    private static String msg(long triedToAllocate, long maxAllowable) {
        return "Tried to allocate " + triedToAllocate + " bytes, but " + maxAllowable +
                " is the maximum allowed. Please open an issue https://issues.apache.org/jira/projects/TIKA" +
                " if you believe this file is not corrupt.";
    }
}
